Skip to content

Social sentiment

Description

Provides market sentiment indicators for a single token, including bullish, bearish, and neutral opinion ratios and summarized content.

Use cases:

  • Comprehensive market sentiment analysis for a token
  • Combine with capital flow data to analyze the relationship between sentiment and price
  • Judge market bullish/bearish bias

Tips:

  • Call this API when natural language input mentions market sentiment, and also call the real-time capital data API for analysis

Data refresh: Updated every 30 minutes

Endpoint

  • Method: POST
  • Path: /open/v1/social-sentiment/getCoinSocialSentiment

Points

  • Points per call: 2

Prerequisites

Obtaining vsTokenId

ConditionDescriptionHow to obtain
Already have vsTokenIdUse the cached vsTokenId directly; no need to query againExtracted automatically from context
Do not have vsTokenIdCall POST /vs-token/listPrerequisite API call

Request parameters

Parameters are sent in the request body as JSON.

ParameterTypeRequiredDescription
vsTokenIdlongYesToken ID

Response fields

Field structure inside the data object only:

FieldTypeActual serialized typeDescription
updateTimelonglongData update time (millisecond timestamp)
vsTokenIdlongstringToken ID
symbolstringstringToken symbol
namestringstringToken name
bullishRationumbernumberBullish sentiment ratio (0–1)
neutralRationumbernumberNeutral sentiment ratio (0–1)
bearishRationumbernumberBearish sentiment ratio (0–1)
bearishContentsarrayarrayBearish summary content list
    englishstringstringEnglish content
    updateTimelonglongContent update time (millisecond timestamp)
neutralContentsarrayarrayNeutral summary content list
    englishstringstringEnglish content
    updateTimelonglongContent update time (millisecond timestamp)
bullishContentsarrayarrayBullish summary content list
    englishstringstringEnglish content
    updateTimelonglongContent update time (millisecond timestamp)

Field semantics

The following fields require additional business context:

FieldBusiness meaningRange / calculationUsage suggestion
bullishRatioBullish sentiment ratio0–1, based on social content sentiment analysisCloser to 1 indicates a more bullish market
neutralRatioNeutral sentiment ratio0–1, based on social content sentiment analysisRepresents the share of wait-and-see sentiment
bearishRatioBearish sentiment ratio0–1, based on social content sentiment analysisCloser to 1 indicates a more bearish market
bullishContentsBullish content summaryAI summary of social contentUnderstand specific reasons for bullish sentiment
bearishContentsBearish content summaryAI summary of social contentUnderstand specific reasons for bearish sentiment

Request example

json
{
    "vsTokenId": 1   // Token ID (vsTokenId)
}

cURL example (Linux/macOS)

bash
curl --location --request POST 'http://${host}/api/open/v1/social-sentiment/getCoinSocialSentiment' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: xxxxx' \
--header 'X-TIMESTAMP: xxxxx' \
--header 'X-SIGN: xxxxx' \
--header 'Accept: */*' \
--data-raw '{
    "vsTokenId": 1
}'

cURL example (Windows CMD)

cmd
curl --location --request POST "http://${host}/api/open/v1/social-sentiment/getCoinSocialSentiment" ^
--header "Content-Type: application/json" ^
--header "X-API-KEY: xxxxx" ^
--header "X-TIMESTAMP: xxxxx" ^
--header "X-SIGN: xxxxx" ^
--header "Accept: */*" ^
--data-raw "{    \"vsTokenId\": 1}"

Sample success response

json
{
    "code": 200,
    "message": "success",
    "data": {
        "updateTime": 1773315931000,               // Data update time
        "vsTokenId": "1",                           // Token ID (vsTokenId)
        "symbol": "BTC",                            // Token symbol
        "name": "Bitcoin",                          // Token name
        "bullishRatio": 0.4113,                     // Bullish sentiment ratio
        "neutralRatio": 0.4937,                     // Neutral sentiment ratio
        "bearishRatio": 0.095,                      // Bearish sentiment ratio
        "bearishContents": [
            {
                "english": "$BTC faces conflicting narratives...", // English content
                "updateTime": 1773316047000          // Content update time
            },
            {
                "english": "$BTC faces intense bearish pressure...",
                "updateTime": 1773314274000
            },
            {
                "english": "Whales and treasury entities...",
                "updateTime": 1773312461000
            }
            // ... more items omitted
        ],
        "neutralContents": [
            {
                "english": "Whales and institutional actors...",
                "updateTime": 1773316047000
            },
            {
                "english": "$BTC remains central to macro speculation...",
                "updateTime": 1773312461000
            },
            {
                "english": "$BTC faces immediate resistance at $70K...",
                "updateTime": 1773310591000
            }
            // ... more items omitted
        ],
        "bullishContents": [
            {
                "english": "$BTC shows strong bullish conviction...",
                "updateTime": 1773316047000
            },
            {
                "english": "Whales are driving momentum...",
                "updateTime": 1773314274000
            },
            {
                "english": "Whales are reactivating long-dormant...",
                "updateTime": 1773312461000
            }
            // ... more items omitted
        ]
    },
    "requestId": "xxx-xxx-xxx"
}